[legacy] Get all drivers assigned to a set of vehicles

Note: This is a legacy endpoint, consider using this endpoint instead. The endpoint will continue to function as documented. Get all driver assignments for the requested vehicles in the requested time range. The only type of assignment supported right now are assignments created through the driver app.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Assignments under the Assignments category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /fleet/vehicles/driver-assignments

[legacy] Get all drivers assigned to a set of vehicles

cURL

curl --request GET \
  --url https://api.samsara.com/fleet/vehicles/driver-assignments \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "driverAssignments": [
        {
          "assignmentType": "driverApp",
          "driver": {
            "id": "45646",
            "externalIds": {},
            "name": "Driver Bob"
          },
          "endTime": "2019-06-13T19:08:25Z",
          "isPassenger": false,
          "startTime": "2019-06-13T19:08:25Z"
        }
      ],
      "id": "494123",
      "externalIds": {},
      "name": "Bus-123"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startTime · string

A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum allowed startTime-endTime range is 7 days.

endTime · string

An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum allowed startTime-endTime range is 7 days.

vehicleIds · string

A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186

tagIds · string

A filter on the data based on this comma-separated list of tag IDs. Example: tagIds=1234,5678

parentTagIds · string

A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: parentTagIds=345,678

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

Response

200

application/json

OK response.

data · object[] · required

List of vehicles and their driver assignments.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes